home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1995 October / EnigmA AMIGA RUN 01 (1995)(G.R. Edizioni)(IT)[!][issue 1995-10][Aminet 7].iso / Aminet / util / misc / QuickIndex093.lha / quickindex / QuickIndex.doc < prev    next >
Text File  |  1995-06-22  |  6KB  |  178 lines
  1.  
  2.  
  3.  
  4.  
  5.                         QuickIndex V0.93 (22-June-1995)
  6.                                by Florian Lohoff
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14. 1. Distribution & Usage
  15.  Quickindex and all related documentation are freeware and may be freely
  16.  distributed and copied. It may not be distributed in a modified form.
  17.  It may not be used for commercial purposes.
  18.  
  19.  QuickIndex may not be included in CD-Rom productions if the end user
  20.  price is higher than 30,- DM.
  21.  
  22.  You use Quickindex at your own risk. This program is provided 'as is' without
  23.  any kind of warranty.
  24.  
  25.  
  26. 2. Introduction
  27.  Quickindex is a program to easily control your local aminet mirror. It is
  28.  supposed to sort and/or comment all aminet files with the short description
  29.  listed in the index file supported from aminet, and this at amazing speed.
  30.  
  31.  
  32.  
  33. 3. Requirements
  34.  An AMIGA would be nice. Rom version V39 (OS3) or higher. A harddrive is
  35.  hardly recommended. You should have at least 3 MB of ram because of the
  36.  size of the Aminet INDEX file which is loaded completely at creation of
  37.  the quickindex. The memory consumption is roughly like this
  38.  
  39.  Index in Use + New Index + 10th of the same
  40.  
  41.  That means
  42.  
  43.  1 MB + 1.2MB + (1MB+1.2MB)/10
  44.  
  45.  But this is only on Quick Index creation
  46.  At search time only the tenth part is in memory. Normally the result index
  47.  is only some lines longer than the old because of duplicat entrys which are
  48.  deleted.
  49.  
  50.  
  51.  
  52. 3. Installation
  53.  If you read this you already unpacked the QuickIndex archieve. Create a
  54.  directory somewhere you want, and copy QuickIndex [and documentation] into
  55.  the dir. There should be at least 2 MB of HD space left to save the sorted
  56.  aminet index + quick index.
  57.  
  58.  
  59.  
  60. 4. Usage
  61.  - The first thing you should do on first startup is adding an Index.
  62.    Just click on the gadget "Add Index" and select an index file of your
  63.    choice. "Recent" & "Local" are also acceptable. Now QuickIndex generates
  64.    a quickindex.
  65.  
  66.  - Second thing should be to define where you want to sort the files in.
  67.    The aminet base path. You only need to do this if you want to sort your
  68.    files into the original Aminet tree. You may select the aminetpath via
  69.    the string gadget or via the "?" gadget where you can use a Path selector.
  70.  
  71.  - The "Action type" gadget selects what QuickIndex should do with the files
  72.    "Comment", "Move", or "Comment&Move".
  73.  
  74.  - The "Exist" cycle gadget selects what QuickIndex should do if file already
  75.    exists in aminet path.
  76.    Normal (And fastest is "Delete Source") but you may "Overwrite" the
  77.    destination file or skip the source file of further processing.
  78.  
  79.  - The "Tree creation" gadget selects what QuickIndex should do if the aminet
  80.    tree is not complete. You may "Create Tree", "Skip file" or "Delete file".
  81.    The last one is useful if you get tapes with lots of stuff but you dont
  82.    want modules out of the aminet. Then you just delete the directory from
  83.    your aminet path and say "Delete File" so that no modules get sorted.
  84.  
  85.  - If one day the index has grown as much that you want to restart Index
  86.    creation just delete "INDEX.QUICK" and "INDEX.SORT" in the QuickIndex
  87.    directory.
  88.  
  89.  Click "Action" to process files. Select the directory with Aminet files.
  90.  
  91. 5. Future
  92.  
  93.  Future enhancements will only be done if i get feedback from users of this
  94.  tool who like to use it.
  95.  
  96.  - Lower memory consumption on QuickIndex creation (and speed loss)
  97.  - Readme support (Short comment/moving with files)
  98.  - External file tester & advert adder
  99.  - Local index
  100.  - Secure index detection
  101.  - Recursive directory search
  102.  - Abort button
  103.  - Progress indicator
  104.  - Amiga guide documentation
  105.  - Different buttons for "New Index" / "Merge index".
  106.  - Add more then one index at once
  107.  
  108.  and maybe even more if you report me.
  109.  
  110.  
  111.  
  112. 6. Bugs
  113.  Report any bug you find and which is not listed below. Read documentation
  114.  carefully before writing a bug report. Maybe it is a feature. Then report
  115.  the bug. Report Amiga type, memory total, memory on execution, Guru number,
  116.  HD space left. Everything which could be in relation with the crash.
  117.  
  118.  There are some bugs.
  119.  - I think you can crash your Amiga by selecting a binaery file as index.
  120.  - There is a bug in some index`s of some Aminet sites. I don`t know which
  121.    but on those index`s the first bytes of the file comment is missing.
  122.    I found no way to detect those index`s, so be careful.
  123.  
  124.  
  125. 7. History
  126.  
  127.  V0.9  - First Release
  128.  
  129.  V0.91 - Little bug caused mem eating when sorting files. 87 Bytes per file.
  130.        - Information of user gave trash if more than one Argument.
  131.  
  132.  V0.92 - Aminet Index has changed. Names are 2 byte longer.
  133.        - Path could be trashed (Leading space/first 2 chars forgotten)
  134.  
  135.  V0.93 - Got 3 more Index line formats. Changed to dynamic extraction.
  136.  
  137.  
  138. 8. Author
  139.  My name is Florian Lohoff. I am 20 years old and doing my "Zivildienst".
  140.  I have got an Amiga since end of 1987. My first Amiga was an A500
  141.  then another one because of a hardware crash of my old. Then a harddrive
  142.  (20MB for 1200,-DM). Then a A2000 with 100MB Harddrive and 5MB of Ram.
  143.  Now i own a A3000T with 1.8GB HD and 9MB in a PC tower case. I am running
  144.  a BBS with 5 lines. I always programmed a lot in Assembly.  Then someday
  145.  i discovered "C" and tried around. This is my first real production in
  146.  this fantastic language. Anyone interested in Electronics & Programming
  147.  feel free to contact me.
  148.  
  149.  
  150.  Mailbox:
  151.  Dataland
  152.  +49 (0)5241-340796 Zyxel E+
  153.              3286   V.FC
  154.              3287   V.V34
  155.              3288   V.32Bis
  156.              3289   V.Terbo
  157.  
  158.  Fido:
  159.   Florian Lohoff@2:2449/845
  160.   Actual version may be requested as magic "QUICKINDEX"
  161.  
  162.  AmigaNet:
  163.   Florian Lohoff@39:170/110
  164.  
  165.  UseNet:
  166.   flohoff@dataland.owl.de
  167.  
  168.  
  169.  Snail Mail:
  170.  Florian Lohoff
  171.  Heidestr 16
  172.  33330 Guetersloh
  173.  Germany
  174.  
  175.  Voice:
  176.  +49 (0)5241 34865
  177.  
  178.